/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the 'License');
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { EngineCapability } from '~/dsl/Defines';
import { EngineCapabilityHint } from '~/extensions/hint/CapabilityHint';
import { PropType } from '~/type';

/**
 * The context for each DSL rule.
 *
 * {@link EngineCapability} is the destructured for easier access.
 *
 * @category DSL
 */
export type RuleContext<Hint extends EngineCapabilityHint = EngineCapabilityHint> = {
    options?: PropType<Hint, 'options'>;
} & EngineCapability<Hint>;

/**
 * The context type builder.
 *
 * @category DSL
 */
export type DefineRuleContext<T, Hint extends EngineCapabilityHint> = RuleContext<Hint> & {
    props: T;
};
